SIP

Trunk

Busies the designated peer. This is a courtesy busy out. Existing calls can complete normally, but new calls are blocked. When a courtesy busy out is used, the number of active calls is displayed. When all calls are completed, the state of the link changes to MAN BUSY.

<PEER_NAME> The peer name is the "Name" from  the Network Elements form, and the name is case sensitive.

Example:

sip busy peer SoftSw2A

SIP BUSY (COURTESY) PEER SoftSw2A succeeded.

Link state changes from IDLE to MAN BUSY.

Trunk

Forces busy on the designed peer name. The calls in progress are dropped.

Trunk and Line side

Displays the following information:

• values for common configuration

• values for the configuration timers

• configuration data for the Registrar

Example:

-------- Sip Configuration ------------

Realm vm25:Address: vm25.abccompany.com 10.40.105.25

Default Expiry Duration:              3600 seconds

Maximum Configurable Expiry Duration: 2592000 seconds

SipProtocolVersion:   SIP/2.0

SipServiceOperStatus: 2

SipServiceStartTime:  1595338708

SipEntityType:        2

TimerA:  500

TimerB:  32000

TimerC:  0

TimerD:  0

TimerE:  500

TimerF:  32000

TimerG:  500

TimerH:  32000

TimerI:  5000

TimerJ:  32000

TimerK:  5000

TimerT1: 500

TimerT2: 4000

TimerT4: 5000

Trunk & Line side

This commands enables you to collect additional information in the MSPLogs file for debugging purposes.

NOTE: Logs must be enabled only when requested by Mitel Technical Support. It is recommended that you enable logs when you try to reproduce the issue during a low traffic period.

To collect additional information, run the command with ON and any of the following qualifiers (for example, SIP DEBUG ON APP, AUX, SSP):

APP - For debugging SIP subscription problem.

AUX - For debugging SIP registration problem.

MH - For debugging SIP media problem.

SSM - For debugging SIP state machine problem.

SSP - For debugging SIP stack problem.

After the command is executed, the information is sent to the MSPLogs file. MSPLogs can be viewed in the Maintenance Logs captured through the System Diagnostics Reporting form. The Maintenance Logs can be shared with Mitel Technical Support for debugging the problem.

Line side

Displays the following information:

• Configuration of the extension and the currently associated registrations or subscriptions.

• Current call status.

Configuration information includes:

• Extension number, type, name, and addressing info

• Overall state information:

•  NOT REGISTERED (no valid registration)

•  ACTIVE (has a valid registration)

• OUTGOING (no active registration but can make outgoing calls)

•  TEMPORARY (temporary registration during a HotDesk log over)

• User Agent string (UA)

• Internal data (SPID and so on)

• Device model, IPEI and MAC address, and HotDesk (HD) data

• Received contact and expiration data

• SIP Device Capability (DevCap) and primary/secondary Cluster Element IDs (CEIDs)

• Other configuration data

• Subscription information: HotDesk (HD), Message Waiting (MWI), and DeviceUserData (DUD)

• Other status information including last event to Call Control (Login, RegAccepted)

Media information includes:

• Start time, remote IP address, calling and called numbers, and SIP Call-ID

• Negotiated media and other internal state information

Example 1: Non-registered device

Extension:1002  (UC Endpoint)  ' Took,Belladonna'  IP [0.0.0.0]:0

  NOT REGISTERED

  DevCap:71      ExtFlags:0001           CEIDs[ 25:27 ]  

  FaxProfile:1   Zone( 25/65536-Default) Canada/Eastern  Vmail:1080           

  Status: ENGLISH NeverRegistered(Thu Apr 23 17:35:17)

Example 2: Registered HotDesk device on a call

Extension:160057  (Mobile)  'Phone,Example'  IP [10.40.105.16]:0

  ACTIVE Registrar Entry: [IN SERVICE HOT DESK-Completed]

    UA: Mitel-Single-Line-UC-Endpoint (MiCollab SIP x160057 ACG_8.0.0.10)

    SPID:   5    ObjID:      38  #Ref:1  Attempts:0       RegFlags:0012

    Model(50/2 ) IPEI                    MAC 303030303536  HD(id:5 DevCap:77)

    CONTACT sip:160057@10.40.105.16:50639 udp Priority:0

            TimeLeft:262 of 300

  DevCap:77      ExtFlags:0021           CEIDs[ 25:27 ]  

  FaxProfile:1   Zone( 25/65536-Default) Vmail:1080           

  Subscriptions: HD(id:5)

  Status: ENGLISH Login(Thu Apr 23 17:38:09)

  MEDIA #1 Started at Thu Apr 23 17:38:36 ID: ef5581a0(2) 10.40.105.16

 6001003 / 1003 CALLED-> 160057  Call-ID: 305369666-4041678970

  Audio AVP sendrecv Remote:[10.40.105.16]:59380 Local:[10.34.20.151]:40036

 StateMediaAnswered(1,17)  StateEstablished(4,0)

 obj=58 rt=0 tc=0 SSPc=0 MHc=0 sdpt=0 flags=1000 200020 904000b1 202010 0

Trunk & Line side

Displays the maintenance commands that are provided for SIP trunks and endpoints.

Trunk

Displays the link state for the selected peer name.

The state can be one of:

"IDLE" - Initial state; no calls have been made on the link.

"IN SERVICE" - The link is in service.

"OUT OF SERVICE" - A temporary or permanent network outage/error was detected on the link.

"VALIDATING" - A new call is being attempted and is bringing the link from OUT OF SERVICE to IN SERVICE, if possible.

"MAN BUSY PENDING" - The link is being busied out, and no new calls can be made. One or more existing calls are still up.

"MAN BUSY" - The link is busied.

"UNKNOWN" - Unexpected error on the system.

Trunk

Displays the link state for all peers.

Example:

sip link state all

There are 2 SIP link(s) programmed.

Peer         41 state is      IN SERVICE.

Peer   SoftSw2A state is            IDLE.

Trunk

Displays the number of established links and non-established links.

Line side

Display all SIP registrations. Examples are provided in the following SIP REGISTRAR commands of specifically listed entries. This command lists all entries.

Example:

Registrar ALL Entries for CEID 25

160047 ACTIVE[IN SERVICE HOT DESK] CEID[25:27] Mobile

    UA:Mitel-Single-Line-UC-Endpoint (MiCollab SIP x160047 ACG_8.0.0.10)

    CONTACT sip:160047@10.40.105.16:49710 udp Priority:0 TimeLeft:187 of 300

1 Entry displayed

Line side

Displays all DECT device registrations by SIP device capabilities (65, 66, 67, 68, 70, 72, 73, 74, 75) or by User-Agent SIP Header containing "dect".

Example:

Registrar DECT  Entries for CEID 25

1005 ACTIVE[IN SERVICE] CEID[25:27] 650

    UA:Mitel SIP-DECT (SW-Version=8.1-EJ02)

    CONTACT sip:1005@10.40.105.7:5061;transport=tls tls Priority:0 TimeLeft:142 of 300

1 Entry displayed

Line side

Displays registrations for a particular SIP device capability, where N is the device capability.

Example:

Registrar DEVCAP 4 Entries for CEID 25

1003 ACTIVE[IN SERVICE] CEID[25:27] Generic SIP

    UA:Aastra 6863i/4.2.0.2023 (MBG/4.12.0.260-01)

    CONTACT sip:dead8b300535@10.223.5.7:5060;transport=tcp tcp Priority:0 TimeLeft:221 of 307

3001 OUTGOING[OUT OF SERVICE] CEID[27:25] Generic SIP

    CONTACT sip:dead3cd5a3dc@10.223.5.7:5060;transport=tcp tcp Priority:0 TimeLeft:236 of 300

2 Entries displayed

Line side

Displays registrations that are logged in as SIP hotdesk users.

Example:

Registrar HOTDESK  Entries for CEID 25

160047 ACTIVE[IN SERVICE HOT DESK] CEID[25:27] Mobile

    UA:Mitel-Single-Line-UC-Endpoint (MiCollab SIP x160047 ACG_8.0.0.10)

    CONTACT sip:160047@10.40.105.16:49710 udp Priority:0 TimeLeft:187 of 300

1 Entry displayed

Line side

Displays devices receiving service on this element as their secondary. In the following example, the primary element's CESID is 24 and the secondary element's CESID is 25.

Example:

Registrar SECONDARY  Entries for CEID 25

2415 ACTIVE [IN SERVICE] CEID[24:25] Generic SIP

    CONTACT sip:2415@10.40.105.91:5060 udp Priority:0 TimeLeft:3107 of 3600

1 Entry displayed

Line side

Displays the following statistics data:

Current Statistics include:

• the total number of registered devices

• the number of registrations treating this element as their secondary

• the number of registrations allowing subscriptions

• the number of current MWI, HotDesk, and Device User Data Subscriptions

Counters (which can be cleared using SIP STATS CLEAR) include the total number of accepted/failed and refreshed registrations, as well as a breakdown of failures and other failures such as time-outs.  Subscriptions successful and failed are also counted.

Example:

vm25 SIP Endpoint Registrar Statistics

                     ---Current---                  ---Counters---

Registrations:            15       Accepted:348        Failed:1          Refreshed:333       

  Active as Secondary:    0         

  Allowing Subscriptions: 14        

Failure Breakdown:                 Rejected:0         

                            400 Bad Request:0         

                              403 Forbidden:0          Blocked:0          

                              404 Not Found:0          

                            423 Min Expires:1         

Other Failures:             Request timeout:0         

                           Response timeout:0         

MWI Subscriptions:        3      Successful:4          Failed:0         

Hotdesk Subscriptions:    9      Successful:10         Failed:0         

DevUserData Subscriptions:0      Successful:0          Failed:0        

Line side

Displays registrations that contain the specified sub-string in their User-Agent header. The following is an example for "IOS" as sub-string.

Example:

Registrar UA IOS Entries for CEID 25

23*303 ACTIVE [IN SERVICE] CEID[25:27] UC Endpoint

    UA: Mitel-UC-Endpoint (UCA_iOS/9.1.330/iPhone8,1/13.3) (MBG/4.12.0.257-01)  Mac Addr

    CONTACT sip:904183affc94@10.223.128.78:5060;transport=udp udp Priority:0 TimeLeft:2591971 of 2592000

1 Entry displayed

Line side

Displays all UC endpoints registrations by SIP device capabilities (71 or 77) or by User-Agent SIP header that contains "uc-endpoint".

Example:

Registrar UA IOS Entries for CEID 25

1076 ACTIVE[IN SERVICE] CEID[25:27] UC Endpoint

    UA:Mitel-UC-Endpoint (Mitel UC360 Collaboration Point/2.1.4.2;  08:00:0F:69:E4:06)

    CONTACT sip:1076@10.40.105.83:5060;transport=tcp tcp Priority:0 TimeLeft:200 of 300

160003 ACTIVE[IN SERVICE HOT DESK] CEID[25:27] Mobile

    UA:Mitel-Single-Line-UC-Endpoint (MiCollab SIP x160003 ACG_8.0.0.10)

    CONTACT sip:160003@10.40.105.16:49709 udp Priority:0 TimeLeft:186 of 300

23*303 ACTIVE [IN SERVICE] CEID[25:27] UC Endpoint

    UA: Mitel-UC-Endpoint (UCA_iOS/9.1.330/iPhone8,1/13.3) (MBG/4.12.0.257-01)  Mac Addr

    CONTACT sip:904183affc94@10.223.128.78:5060;transport=udp udp Priority:0 TimeLeft:2591971 of 2592000

3 Entries displayed

Trunk

Forces SIP Peer profiles associated with the specified network element to reregister with its registrar.

Trunk

Returns the busied peer to service.

Example:

sip rts peer SoftSw2A

SIP RTS PEER SoftSw2A succeeded.

Link state changes from MAN BUSY to IDLE.

Trunk & Line side

Displays all SIP calls in progress in the network

CAUTION: Do not use this command if there is an indication or suspicion of a problem on the SIP service.

Trunk

Displays all SIP calls in progress on the specified network element.

Trunk

Displays all SIP calls in progress for a specific profile name.

Trunk & Line side

Provides counters related to SIP traffic for both trunks and line side devices.

Incoming and outgoing counts provided for total requests and responses. A breakdown by message type and response code is also provided. Other detailed counts related to discarded messages, congestion, retransmissions, and other internal indicators are also provided.

Example:

---- Overall SIP Statistics Summary ----

          Incoming, Outgoing

Requests       229, 104

Responses      120, 351

Options         11, 7  

Invite           5, 2

Ack              5, 2

Options         63, 13

Bye              1, 1

Prack            0, 1

Register        60, 7

Subscribe       65, 2

Notify          30, 76

100             32, 70

180              1, 0

200             87, 222

401              0, 52

404              0, 4

423              0, 2

489              0, 1

Unsupported Methods       0

Discarded Small Msgs      0

Discarded Invalid Msgs    0

Discarded Congested Msgs  0

Retransmissions Received  0

Retransmissions Sent      0

Dropped Syslog Packets    0

Internal indicators below

Q HighWater STS 1 SSP 4 SSM 1 STIC 0 SLM 7 SIPMH 2 AUX 13 DM 1 NTM 1

            orh 2 Apps [4] 2

SSP interval between servicing network HighWater 5ms

SSP count of intervals with long delay (over 60ms) = 0

Trunk & Line side

Resets the dynamic User-Agent/Server cache and clear stats collected by the commands SIP STATS TRUNKS, and SIP REGISTRAR STATS.

Trunk

Displays statistics data for all the SIP profiles/links including the total. Stats are collected from the time, the system was last started, unless cleared since then by the maintenance command SIP STATS CLEAR.

• Active Calls (Incoming/Outgoing): The number of current active calls.

• Non-Auth Calls (Incoming/Outgoing): The number of calls processed which were not authenticated.

• Auth Calls (Incoming/Outgoing): The number of calls processed which were authenticated.

• Max Calls: The maximum number of calls being simultaneously processed.

• Alt Routing: The number of outgoing calls that were sent to alternate routing when the number of licenses were exceeded or the link was down.

• Auth Failures (Incoming/Outgoing): The number of calls that were failed due to an authentication error.

• Rejected Calls (Incoming/Outgoing): The number of calls that were rejected due to an error situation. This does not include authentication failures.

• Cancelled Calls (Incoming/Outgoing): The number of calls that were cancelled before the answer state.

• Short Calls (Incoming/Outgoing): The number of answered calls that had a talk time of less than 5 seconds.

• Forked Calls: The number of outgoing calls that used SIP Forking (had multiple responses with different to-tags).

Trunk

Displays statistics data for a specific profile name, including the number of active calls, rejected calls, non-authorized calls, authorized calls, and authorized failures.

Trunk & Line side

This command is used to start and stop SIP tracing directly to the maintenance command window. The tracing directly to the window is limited and will be terminated once 50 Kbytes of data is passed to the command window.

<TAIL_FLAG> = ON or OFF

Trunk & Line side

This command is similar to the SIP TCPDUMP ON command, except that it generates additional SIP module logging information in the SIP TCPDUMP file.

Example:

SIP TCPDUMP ALL

SIP TCPDUMP ALL Started...

NOTE: Running this command during peak service can affect system performance.

Trunk & Line side

This command is similar to the SIP TCPDUMP ALL command, except that it generates logging information in the SIP TCPDUMP file only for the specified called or calling number.

Example:

SIP TCPDUMP CCN 435

SIP TCPDUMP CCN 435 Started...

NOTE: The called or calling number can be a complete or partial number. If the specified number matches many calls in the log file, then this command can affect the system performance during peak service.

Trunk & Line side

Clears the directory of old files.

Example:

SIP TCPDUMP CLEAR

SIP TCPDUMP Files Cleared

Trunk & Line side

Starts capturing SIP signalling data on the MiVoice Business system in tcpdump file format. The captured data is saved into files in the /Vmail folder with the names in the format of WS_xxxxxx.pcap. A maximum of 20 compressed files of approximately 5-Mbyte size can be created by MiVoice Business.

To collect the most recently captured data and other diagnostic information:

• For Container-based MiVoice Business (cMiVB), you can collect most recent captures data from the Maintenance and Diagnostics > System Diagnostics Reporting form in the System Administration Tool.

• For all other platforms, download the SOS report from Administration > View log files in Server Manager.

If logging is left running for a long time and multiple files are created, you can manually download all the data using sftp or scp. Only the most recent file is automatically downloaded in the diagnostics collections mentioned above.

NOTES

• After SIP TCPDUMP data is retrieved and is no longer required on the MiVoice Business system, it is strongly recommended that you use the SIP TCPDUMP CLEAR command to clear the used disk space.

• For all platforms except Container-based MiVoice Business (cMiVB), the SOS report generated contains the latest SIP TCPDUMP file. For Container-based MiVoice Business (cMiVB) the system diagnostics information contains the latest SIP TCPDUMP file.